Index template定义在创建新index时可以自动应用的settings和mappings。 Elasticsearch根据与index名称匹配的index模式将模板应用于新索引。这个对于我们想创建的一系列的Index具有同样的settings及mappings。比如我们希望每一天/月的日志的index都具有同样的设置。
Index template仅在index创建期间应用。 对index template的更改不会影响现有索引。 create index API请求中指定的设置和映射会覆盖索引模板中指定的任何设置或映射。
你可以在代码中加入像C语言那样的block注释。你可以把这个注释放在出来开头 “{”和结尾的“}”之间的任何地方。
定义一个Index template
我们可以使用如下的接口来定义一个index template:
1 | PUT /_template/<index-template> |
我们可以使用_template这个终点来创建,删除,查看一个index template。下面,我们来举一个例子:
1 | PUT _template/logs_template |
在上面,我们可以看到,我们定义了一个叫做logs_template的index template。它的index_patterns定义为“logs-*”,说明,任何以“logs-”为开头的任何一个index将具有在该template里具有的settings及mappings属性。这里的“order”的意思是:如果索引与多个模板匹配,则Elasticsearch应用此模板的顺序。该值为1,表明有最先合并,如果有更高order的template,这个settings或mappings有可能被其它的template所覆盖。
下面,我们来测试一下我们刚定义的index template:
1 | PUT logs-2019-03-01 |
在这里,我们创建了一个叫做logs-2019-03-01的index。我们使用如下的命令来检查被创建的情况:
1 | GET logs-2019-03-01 |
显示的结果为:
1 | { |
证如上所示,我们已经成功创建了一个我们想要的index,并且它具有我们之前定义的settings及mappings。
Index template和alias
我们甚至可以为我们的index template添加index alias:
1 | PUT _template/logs_template |
在上面,我们已经创立了一个叫做{index}-alias的别名。这里的{index}就是实际生成index的文件名来代替。我们下面用一个例子来说明:
1 | PUT logs-2019-04-01 |
我们创建一个叫做logs-2019-04-01的index, 那么它同时生成了一个叫做logs-2019-04-01-alias的别名。我们可以通过如下的命令来检查:
1 | GET logs-2019-04-01-alias |
显示的结果是:
1 | { |
Index匹配多个template
多个索引模板可能与索引匹配,在这种情况下,设置和映射都合并到索引的最终配置中。 可以使用order参数控制合并的顺序,首先应用较低的顺序,并且覆盖它们的较高顺序。 例如:
1 | PUT /_template/template_1 |
以上的template_1将禁用存储_source
,但对于以te *
开头的索引,仍将启用_source。 注意,对于映射,合并是“深度”的,这意味着可以在高阶模板上轻松添加/覆盖特定的基于对象/属性的映射,而较低阶模板提供基础。
我们可以来创建一个例子看看:
1 | PUT test10 |
显示的结果是:
1 | { |
如果我们创建另外一个不是以 “te”开头的index,我们可以看看如下的情况:
1 | PUT my_test_index |
显示的结果是:
1 | { |
显然在mappings里显示source是被禁止的。
如果对于两个templates来说,如果order是一样的话,我们可能陷于一种不可知论的合并状态。在实际的使用中必须避免。
查询Index template接口
我们可以通过如下的接口来查询已经被创建好的index template:
1 | GET /_template/<index-template> |
比如:
1 | GET _template/logs_template |
显示的结果是:
1 | { |
显示的内容就是我们之前已经创建的那个index template。
你也可以通过如下的方式来同时查询多个template的情况:
1 | GET /_template/template_1,template_2 |
删除一个index template
在之前的练习中,我们匹配“*”,也就是我们以后所有的创建的新的index将不存储source,这个显然不是我们所需要的。我们需要来把这个template进行删除。删除一个template的接口如下:
1 | DELETE /_template/<index-template> |
那么针对我们的情况,我们可以使用如下的命令来删除我们不需要的template:
1 | DELETE _template/template_1 |
这样我们删除了我们刚才创建的两个templates。
参考:
【1】https://www.elastic.co/guide/en/elasticsearch/reference/7.4/indices-get-template.html
【2】https://www.elastic.co/guide/en/elasticsearch/reference/7.4/indices-delete-template.html
【3】https://www.elastic.co/guide/en/elasticsearch/reference/7.4/indices-templates.html